docs(client): fix incorrect comment about timeout calculation. #2252
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ic or functional changes.
|
thanks for reporting, the current comment is indeed correct but I think this fix is wrong as well? I think instead it should be this? # Reduce the calculated timeout by a random range between 0-25% |
It seems good to me! I have revised the same for unity, referring to the same functionality code in openai-node repo, but I think the method you suggested is much reasonable. So I revised the comment as you suggested. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes being requested
Existing annotations misrepresent code behavior; therefore, changed it to comment that correctly describes code behavior.
Additional context & links
AS-IS
openai-python/src/openai/_base_client.py
Lines 706 to 709 in f66d2e6
jitteris a number in the range (0.75, 1] and is multiplied onsleep_secounds. Therefore, the description "Apply some jitter, plus-or-minus half a second." is incorrect.Code FixvsComment FixBy referring to the same functionality code in openai-node repo, we can infer that multiplying the
jitterbysleep_secondis the intended behavior, so I decided to revise comment.